Skip to content

[docs] Simplify and update tutorials - #1690

Merged
minggangw merged 6 commits into
RobotWebTools:developfrom
minggangw:fix-1689
Nov 19, 2026
Merged

minggangw merged 6 commits into
RobotWebTools:developfrom
minggangw:fix-1689

Conversation

@minggangw

Copy link
Copy Markdown
Member
  • Simplify the tutorial index and build on the existing first-nodes guide.
  • Replace repetitive fragments with runnable ES-module examples and ROS 2 CLI commands.
  • Correct parameter validation, lifecycle cleanup, action cancellation, and observable subscription guidance.
  • Clarify DDS filtering support, service-event delivery, and type-description discovery.
  • Update ROS 2 Lyrical reference links.

Fix: #1689

Copilot AI balanced review requested due to automatic review settings November 18, 2026 03:11

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues were identified for the tutorial updates.

No open issues 🎉

What changed in this PR

Simplifies the rclnodejs tutorials for #1689, building on the existing first-nodes guide with shorter, practical examples and clearer API guidance.

Changes:

  • Reorganizes the tutorial index and replaces repetitive examples with ES modules and ROS 2 CLI walkthroughs.
  • Updates guidance on parameter validation, lifecycle cleanup, action cancellation, and observable subscription ownership.
  • Clarifies middleware filtering, service-event delivery, and type discovery, and refreshes ROS 2 Lyrical links.
File Description
tutorials/​type-description-service.md Adds a focused endpoint-discovery and type-query walkthrough.
tutorials/​service-introspection.md Simplifies event monitoring and explains delivery and correlation limits.
tutorials/​README.md Groups tutorials by configuration, communication, and inspection.
tutorials/​parameter-service.md Updates validation, startup overrides, and callback guidance.
tutorials/​observable-subscriptions.md Demonstrates stream processing and distinguishes cleanup responsibilities.
tutorials/​lifecycle-nodes.md Shows reusable lifecycle resources, cleanup, and CLI transitions.
tutorials/​content-filtering-subscription.md Clarifies middleware support, filter updates, and traffic limitations.
tutorials/​actionlib.md Provides server/client examples with feedback and cooperative cancellation.

Review effort: Balanced

@coveralls

coveralls commented Nov 18, 2026 •

Copy link
Copy Markdown

Coverage Status

coverage: 91.355%. remained the same — minggangw:fix-1689 into RobotWebTools:develop

@minggangw
minggangw merged commit cb6a815 into RobotWebTools:develop Nov 19, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Simplify and update tutorials

3 participants